<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1-20130512"/>
<title>3D Cell: Plane Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">3D Cell
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1-20130512 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_plane-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Plane Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A plane class.  
 <a href="class_plane.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="csg__type_8h_source.html">csg_type.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2ac0fd939beb69bf926faae570f4266f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#a2ac0fd939beb69bf926faae570f4266f">Plane</a> (<a class="el" href="class_vector3.html">Vector3</a> _normal, double _w)</td></tr>
<tr class="memdesc:a2ac0fd939beb69bf926faae570f4266f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor.  <a href="#a2ac0fd939beb69bf926faae570f4266f">More...</a><br/></td></tr>
<tr class="separator:a2ac0fd939beb69bf926faae570f4266f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac96f60e45fa8a67229e9654e69841b45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#ac96f60e45fa8a67229e9654e69841b45">clone</a> ()</td></tr>
<tr class="memdesc:ac96f60e45fa8a67229e9654e69841b45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone a new plane from this plane.  <a href="#ac96f60e45fa8a67229e9654e69841b45">More...</a><br/></td></tr>
<tr class="separator:ac96f60e45fa8a67229e9654e69841b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cbc7559ee7d31b1950d7afa1e30635f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#a9cbc7559ee7d31b1950d7afa1e30635f">invert</a> ()</td></tr>
<tr class="memdesc:a9cbc7559ee7d31b1950d7afa1e30635f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert the plane.  <a href="#a9cbc7559ee7d31b1950d7afa1e30635f">More...</a><br/></td></tr>
<tr class="separator:a9cbc7559ee7d31b1950d7afa1e30635f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7972726302a39271ecce6a069d053d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#ab7972726302a39271ecce6a069d053d8">splitPolygon</a> (<a class="el" href="class_my_polygon.html">MyPolygon</a> *polygon, vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;coplanarFront, vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;coplanarBack, vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;front, vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;back)</td></tr>
<tr class="memdesc:ab7972726302a39271ecce6a069d053d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use this plane to split a polygon.  <a href="#ab7972726302a39271ecce6a069d053d8">More...</a><br/></td></tr>
<tr class="separator:ab7972726302a39271ecce6a069d053d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a338da57ef85d4d8d32d80a8674e90ab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#a338da57ef85d4d8d32d80a8674e90ab7">normal</a></td></tr>
<tr class="memdesc:a338da57ef85d4d8d32d80a8674e90ab7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The normal of the plane.  <a href="#a338da57ef85d4d8d32d80a8674e90ab7">More...</a><br/></td></tr>
<tr class="separator:a338da57ef85d4d8d32d80a8674e90ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eb55b72cfed8e065ea2bd71a3b01db2"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_plane.html#a2eb55b72cfed8e065ea2bd71a3b01db2">w</a></td></tr>
<tr class="memdesc:a2eb55b72cfed8e065ea2bd71a3b01db2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The position of the plane in function ax+by+cz+w=0.  <a href="#a2eb55b72cfed8e065ea2bd71a3b01db2">More...</a><br/></td></tr>
<tr class="separator:a2eb55b72cfed8e065ea2bd71a3b01db2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A plane class. </p>
<p>Represents a plane by function ax+by+cz+w=0, and (a, b, c) is the normal of the plane. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2ac0fd939beb69bf926faae570f4266f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Plane::Plane </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_vector3.html">Vector3</a>&#160;</td>
          <td class="paramname"><em>_normal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>_w</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_normal</td><td>the normal of the plane. </td></tr>
    <tr><td class="paramname">_w</td><td>the position of the plane in function ax+by+cz+w=0. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac96f60e45fa8a67229e9654e69841b45"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_plane.html">Plane</a> * Plane::clone </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clone a new plane from this plane. </p>

</div>
</div>
<a class="anchor" id="a9cbc7559ee7d31b1950d7afa1e30635f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Plane::invert </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Invert the plane. </p>

</div>
</div>
<a class="anchor" id="ab7972726302a39271ecce6a069d053d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Plane::splitPolygon </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_my_polygon.html">MyPolygon</a> *&#160;</td>
          <td class="paramname"><em>polygon</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>coplanarFront</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>coplanarBack</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>front</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&lt; <a class="el" href="class_my_polygon.html">MyPolygon</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>back</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Use this plane to split a polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polygon</td><td>the splited polygon. </td></tr>
    <tr><td class="paramname">coplanarFront</td><td>if the plane and the polygon are coplanar and the polygon in the front of the plane, store the polygon in this std::vector. </td></tr>
    <tr><td class="paramname">coplanarBack</td><td>if the plane and the polygon are coplanar and the polygon in the back of the plane, store the polygon in this std::vector. </td></tr>
    <tr><td class="paramname">front</td><td>if the splited part of the polygon is in the in the front of the plane, store the splied part of polygon in this std::vector. </td></tr>
    <tr><td class="paramname">back</td><td>if the splited part of the polygon is in the in the back of the plane, store the splied part of polygon in this std::vector. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a338da57ef85d4d8d32d80a8674e90ab7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vector3.html">Vector3</a> Plane::normal</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The normal of the plane. </p>

</div>
</div>
<a class="anchor" id="a2eb55b72cfed8e065ea2bd71a3b01db2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double Plane::w</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The position of the plane in function ax+by+cz+w=0. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="csg__type_8h_source.html">csg_type.h</a></li>
<li><a class="el" href="csg__type_8cpp.html">csg_type.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jul 9 2013 15:49:58 for 3D Cell by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1-20130512
</small></address>
</body>
</html>
